accurrent2 2.2.1
Loading...
Searching...
No Matches
AC Current 2 Click Driver

API for configuring and manipulating AC Current 2 Click driver. More...

Topics

 AC Current 2 Settings
 Settings of AC Current 2 Click driver.
 AC Current 2 MikroBUS Map
 MikroBUS pin mapping of AC Current 2 Click driver.

Functions

void accurrent2_cfg_setup (accurrent2_cfg_t *cfg)
 AC Current 2 configuration object setup function.
void accurrent2_drv_interface_sel (accurrent2_cfg_t *cfg, accurrent2_drv_t drv_sel)
 AC Current 2 driver interface setup function.
err_t accurrent2_init (accurrent2_t *ctx, accurrent2_cfg_t *cfg)
 AC Current 2 initialization function.
err_t accurrent2_read_raw_adc (accurrent2_t *ctx, uint16_t *raw_adc)
 AC Current 2 read raw ADC value function.
err_t accurrent2_read_voltage (accurrent2_t *ctx, float *voltage)
 AC Current 2 read voltage level function.
err_t accurrent2_read_voltage_avg (accurrent2_t *ctx, uint16_t num_conv, float *voltage_avg)
 AC Current 2 read average voltage level function.
err_t accurrent2_set_vref (accurrent2_t *ctx, float vref)
 AC Current 2 set vref function.
err_t accurrent2_read_current (accurrent2_t *ctx, float *current)
 AC Current 2 read current function.

Detailed Description

API for configuring and manipulating AC Current 2 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ accurrent2_cfg_setup()

void accurrent2_cfg_setup ( accurrent2_cfg_t * cfg)

AC Current 2 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See accurrent2_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ accurrent2_drv_interface_sel()

void accurrent2_drv_interface_sel ( accurrent2_cfg_t * cfg,
accurrent2_drv_t drv_sel )

AC Current 2 driver interface setup function.

This function sets a serial driver interface which will be used further in the Click driver.

Parameters
[out]cfg: Click configuration structure. See accurrent2_cfg_t object definition for detailed explanation.
[in]drv_sel: Driver interface selection. See accurrent2_drv_t object definition for detailed explanation.
Returns
Nothing.
Note
This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

◆ accurrent2_init()

err_t accurrent2_init ( accurrent2_t * ctx,
accurrent2_cfg_t * cfg )

AC Current 2 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters
[out]ctx: Click context object. See accurrent2_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See accurrent2_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ accurrent2_read_current()

err_t accurrent2_read_current ( accurrent2_t * ctx,
float * current )

AC Current 2 read current function.

This function reads the current measurement from the AC Current sensor (30A/1V).

Parameters
[in]ctx: Click context object. See accurrent2_t object definition for detailed explanation.
[out]current: Pointer to store the measured current value in Amperes.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ accurrent2_read_raw_adc()

err_t accurrent2_read_raw_adc ( accurrent2_t * ctx,
uint16_t * raw_adc )

AC Current 2 read raw ADC value function.

This function reads raw ADC value.

Parameters
[in]ctx: Click context object. See accurrent2_t object definition for detailed explanation.
[out]raw_adc: Output ADC result.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ accurrent2_read_voltage()

err_t accurrent2_read_voltage ( accurrent2_t * ctx,
float * voltage )

AC Current 2 read voltage level function.

This function reads raw ADC value and converts it to proportional voltage level.

Parameters
[in]ctx: Click context object. See accurrent2_t object definition for detailed explanation.
[out]voltage: Output voltage level [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered reference voltage.

◆ accurrent2_read_voltage_avg()

err_t accurrent2_read_voltage_avg ( accurrent2_t * ctx,
uint16_t num_conv,
float * voltage_avg )

AC Current 2 read average voltage level function.

This function reads a desired number of ADC samples and calculates the average voltage level.

Parameters
[in]ctx: Click context object. See accurrent2_t object definition for detailed explanation.
[in]num_conv: Number of ADC samples.
[out]voltage_avg: Average output voltage level [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered reference voltage.

◆ accurrent2_set_vref()

err_t accurrent2_set_vref ( accurrent2_t * ctx,
float vref )

AC Current 2 set vref function.

This function sets the voltage reference for AC Current 2 Click driver.

Parameters
[in]ctx: Click context object. See accurrent2_t object definition for detailed explanation.
[in]vref: Reference voltage (volts).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The default voltage reference set with accurrent2_init is 3.3V.